API Docs

To get started using the Spark API, please take the following steps.

  1. Head to [REMOVED: Get started] to get yourself an API key.

  1. Make a request to the following endpoint,
https://stats.filspark.com/miners/retrieval-success-rate/summary

with the following query parameters,

Query ParameterDescriptionFormatExample
fromThe start date of the data to be aggregated overyyyy-mm-dd2024-03-01
toThe end date of the data to be aggregated overyyyy-mm-dd2024-04-01

and the following request header.

Query ParameterDescriptionFormatExample
Authorization“Bearer” + <The API key that you received in Step 1>stringBearer abcdef

Using the example values in the above table, this will result in the following full request endpoint.

headers: Authorization: "Bearer <API Key>"
https://stats.filspark.com/miners/retrieval-success-rate/summary?from=2024-03-01&to=2024-04-01